home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / man / ttt.1 < prev   
Encoding:
Text File  |  1991-08-16  |  4.3 KB  |  93 lines
  1. ' $Header: /sprite/src/cmds/man/RCS/man.man,v 1.6 91/01/08 21:48:08 tve Exp $ SPRITE (Berkeley)
  2. .so \*(]ltmac.sprite
  3. .HS MAN cmds
  4. .BS
  5. .SH NAME
  6. man \- Print entries in the user reference manual
  7. .SH SYNOPSIS
  8. \fBman\fR [\fIoptions\fR] [\fIsectionNumber\fR] \fIentryName entryName ...\fR
  9. .SH OPTIONS
  10. .IP "\fB\-c \fIconfigFile\fR" 15
  11. \fBMan\fR normally looks in the file \fB/sprite/lib/man/config\fR for
  12. information about where the man pages are.  If the \fB\-c\fR switch is given,
  13. then \fBman\fR uses \fIconfigFile\fR instead.
  14. .IP "\fB\-i\fR" 15
  15. Generate index.  Instead of printing manual entries, treat each
  16. \fIentryName\fR as a file name.  Read all the files, and output index
  17. information on standard output.
  18. .IP "\fB\-help\fR" 15
  19. Print a summary of the command-line options and exit without printing
  20. any manual pages.
  21. .IP "\fB\-k\fR" 15
  22. Keyword search.  Instead of printing manual entries, treat each \fIentryName\fR
  23. argument as a keyword, search the manual indexes for information about
  24. the keywords, and print all the matching index entries.
  25. .IP "\fB\-r\fR" 15
  26. Normally, \fBman\fR retains formatted versions of man pages for faster printing.
  27. It only reformats a man page if there is no formatted version or if the
  28. source is newer than the formatted version.  This switch causes \fBman\fR to
  29. reformat the man page even if the formatted copy appears to be up-to-date.
  30. .IP "\fB\-s \fIsectionName\fR" 15
  31. Check only in section \fIsectionName\fR of the manual for the desired
  32. entries.
  33. .IP "\fB\-t\fR" 15
  34. Print the manual entries on the printer instead of on
  35. standard output.
  36. .IP "\fB\-\fR" 15
  37. \fBMan\fR normally filters the man pages through \fBmore -s\fR to break up
  38. the output and process underline and boldface requests.  If the \fB\-\fR
  39. switch is given, then the \fBmore\fR filter is omitted, and the \fBnroff\fR
  40. output is passed directly to standard output. The \fBPAGER\fP environment
  41. variable can be set to the name of a program to use instead of \fBmore\fP.
  42. .BE
  43.  
  44. .SH DESCRIPTION
  45. .PP
  46. The \fBman\fR program locates and prints one or more entries of the
  47. Sprite reference manual.  The entries are given by the \fIentryName\fR
  48. arguments;  these are usually the names of programs or library
  49. procedures.  Normally, \fBman\fR searches the entire manual and invokes
  50. \fBmore\fR to print the
  51. first entry that matches each \fIentryName\fR.  The manual is divided
  52. into sections, and it is possible for the same name to be used for
  53. entries in different sections.  You may use the
  54. \fB\-s\fR switch to specify a particular section;  in this case, \fBman\fR
  55. will look only in the named section.  Section names include both the
  56. traditional UNIX names (\fB1\fR, \fB2\fR, etc.) and the Sprite names
  57. (\fBcmds\fR, \fBlib\fR, \fBlib/c\fR, \fBdev\fR, etc.).
  58. You may specify a section name without the \fB\-s\fR switch
  59. if the section name starts with a number and is entered as the first
  60. \fIentryName\fR.
  61. .PP
  62. The default configuration file causes the current directory to be
  63. searched for the desired manual entry before the system directories.
  64. If there is a file \fIentryName\fB.man\fR in the current directory,
  65. then it will be printed in preference to any entries in the system
  66. area.
  67. .PP
  68. The \fB\-i\fR switch causes \fBman\fR to generate an index
  69. instead of printing a manual page.  Each \fIentryName\fR argument
  70. is taken to be a file name.  \fBMan\fR will read all the files and
  71. output index information for them on standard output.  Normally, each
  72. directory containing installed unformatted manual entries also has
  73. a file named \fBindex\fR containing index information for all the files
  74. in the directory.  When printing manual entries, if \fBman\fR cannot
  75. locate a file for a given \fIentryName\fR, then it reads the \fBindex\fR
  76. files to see if \fIentryName\fR is an alternate name for some other
  77. manual entry (an alternate name is any name listed in the \fBNAME\fR
  78. section of the entry).
  79. .PP
  80. The \fB\-k\fR switch causes \fBman\fR to perform a keyword search instead
  81. of printing a manual page.  Each \fIentryName\fR argument is taken to
  82. be a keyword, and \fBman\fR searches all the \fBindex\fR files for
  83. entries that match the keywords.
  84. Each matching entry is printed on standard output in a human-readable form.
  85. A keyword matches an index entry if
  86. it is a substring of any of the entry's name, synopsis, or keyword fields.
  87.  
  88. .SH FILES
  89. /sprite/lib/man/config \- default configuration file
  90.  
  91. .SH KEYWORDS
  92. help, index, keyword, manual, reference, section
  93.